Document i18n cache key prefix and configurable cache config (5.next)#8289
Draft
dereuromark wants to merge 2 commits into5.nextfrom
Draft
Document i18n cache key prefix and configurable cache config (5.next)#8289dereuromark wants to merge 2 commits into5.nextfrom
dereuromark wants to merge 2 commits into5.nextfrom
Conversation
Documents the new `TranslatorRegistry::setCacheKeyPrefix()`, `clearInMemoryRegistry()` and `I18n::setCacheConfig()` APIs added in 5.4.0, with the multi-tenant translation cache isolation use case as the worked example. Also adds entries to the 5.4 migration guide.
Reflects the rename from `clearInMemoryRegistry()` after review feedback.
markstory
reviewed
Apr 30, 2026
Comment on lines
+571
to
+577
| When a single application serves multiple tenants and a custom loader produces | ||
| different messages for the same domain and locale per tenant, the default | ||
| translator cache will mix tenants together — the persistent cache key | ||
| (`translations.{domain}.{locale}`) and the in-memory registry don't know about | ||
| tenants. | ||
|
|
||
| Two small APIs solve this without introducing global tenant state. |
Member
There was a problem hiding this comment.
Suggested change
| When a single application serves multiple tenants and a custom loader produces | |
| different messages for the same domain and locale per tenant, the default | |
| translator cache will mix tenants together — the persistent cache key | |
| (`translations.{domain}.{locale}`) and the in-memory registry don't know about | |
| tenants. | |
| Two small APIs solve this without introducing global tenant state. | |
| If your application needs to serve tenant specific translated content for a given domain & locale, you need to use a cache key prefix to scope both translator cache data to the tenant. |
I think we can be more succinct here. Do we need to explain all the internals?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the new i18n APIs landing in cakephp/cakephp#19412:
TranslatorRegistry::setCacheKeyPrefix()— adds a prefix segment to boththe persistent cache key and the in-memory lookup bucket. Accepts a static
string or a
Closure(string $name, string $locale): stringfor pullingthe current tenant from user-land.
TranslatorRegistry::clearInMemoryRegistry()— drops the in-memorytranslator map without touching the persistent cacher. For long-running
workers that switch tenants between jobs.
I18n::setCacheConfig()— replaces the hardcoded_cake_translations_Cache config with whichever config the app prefers. Throws if called
after the registry has been built.
Adds an "Isolating Translations Per Tenant" subsection to the i18n core
library page covering the bootstrap snippet, per-package skip logic via
the
Closurearguments, the queue-worker reset pattern, and thesetCacheConfig()ordering requirement. Also notes thatsetCacheKeyPrefix()is unrelated to the gettext message context used by__x().Adds three bullets to the 5.4 migration guide under I18n new features.
Depends on cakephp/cakephp#19412.